home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / utilitys / 93 / asl / asl.doc next >
Encoding:
Text File  |  1987-10-12  |  9.7 KB  |  201 lines

  1.  
  2.  
  3. May 6, 1987.
  4.  
  5.  
  6.                         DOCUMENTATION FOR ASL.TTP
  7.                         =========================
  8.  
  9.                         by: Ignac A. Kolenko Jr.
  10.                             and Darek Mihocka
  11.  
  12.  
  13.      This program was begun back in late March for the lack of anything better
  14. to do. From my original idea of "Hey, it can't be too hard to write a full
  15. screen editor!" came the first release of ASL.TTP, also known as "The ST
  16. Super Lister". This is a very easy to use, text based (with very quick text
  17. blitting routines which blow away TOS text plotting routines completely)
  18. program with provisions for viewing, in either medium or high resolutions,
  19. either 25 rows and 50 rows of text (50 rows only in monochrome!!) at at time,
  20. with full scrolling capabilities. It has 10 built in buffers, so that you may
  21. view more than one file at a time. This feature is great for comparing source
  22. code with an error listing from a compiler, or anything you wish to view (it
  23. even lets you view .PRG and .TOS file, although why would you??) It also prints
  24. out the files in the buffers, in a straight text dump, or formatted with line
  25. numbers and page headers.
  26.  
  27.  
  28. Running The Program
  29. -----------------
  30.      Since there are 10 buffers, you can place up to 10 file names on the
  31. TOS commandline, and all programs will load in before the menu bar appears.
  32. If the commandline has no arguments, then the program will load with all
  33. buffers initially clear. If you have valid files in the commandline, due to a
  34. bug, the filename won't show up until you view the files or change buffers.
  35.  
  36.      It may be better to run the program from a commandline interpreter (CLI)
  37. since under GEM, Atari has idiotically made the .TTP commandline dialog box so
  38. small (the commandline is about 40 char. long)!!!
  39.  
  40.  
  41. Using The Program
  42. -----------------
  43.  
  44.      The first thing you will see is the text based menu bar. The menu bar is
  45. very easy to use. Simply press the left or right arrow keys until you
  46. highlight the choice you want. Then press <RETURN>. If there are options for
  47. that choice, then a drop down menu will appear. In this case (actually, all
  48. cases except for exit) all you have to do is move using the up and down arrow
  49. keys, and make a selection using <RETURN>. If you move the cursor from the
  50. first highlighted drop down menu item upwards, then control returns back to the
  51. initial horizontal menu bar. That way, it is easy to get out of making a choice
  52. due to pressing <RETURN> at the wrong time.
  53.  
  54.      The first menu choice is 'INFO'. This choice will present to you two drop
  55. down menu items, the first, 'PROGRAM' being general program information, the
  56. second, 'HELP' being, naturally, a help screen for the main menu.
  57.  
  58.      The second menu choice is 'FILE'. This choice presents a drop down menu
  59. with five different items, all file oriented. The first item is 'DRIVE', which
  60. will allow you to reset the current drive to any other that is logged onto your
  61. system at the time. If you choose this option and do not wish to change the
  62. drive, then simply press <RETURN>, which will use the default drive, the one
  63. that the program resides on currently.
  64.  
  65.      The next item is 'PATH'. This option will change the currently logged on
  66. path name of course. Here, simply type in the new path name, and if you don't
  67. wish to change it, just press <RETURN>. Next comes 'LOAD'. This choice will,
  68. as the name suggests, load files into buffers. At the prompt, just enter the
  69. filename of the file you wish to view (only the filename, which consists of
  70. eight letters, plus a three letter extension, since you have set up the drive
  71. and pathname earlier!) The program will either tell you its loading, or tell
  72. you that the file does not exist, and make you press any key to return to the
  73. menu.
  74.  
  75.      The fourth item is 'DIRECTORY'. This option will display a directory of
  76. the current subdirectory you are under, as shown in the status line at the
  77. bottom of the screen. It will also tell you how much space is left on the drive
  78. as well.
  79.  
  80.      The final item is 'RUN PROGRAM'. This item will allow you to run other
  81. programs from within this program, sort of like a mini-shell. The commandline
  82. is 128 characters long, which should be more than sufficient for most appli-
  83. cations. If the commandline is not valid (ie, such as trying to run a program
  84. that does not exist), the program will respond with an appropriate message.
  85. If it is, then the program responds with a successful execution message.
  86.  
  87.      The third main menu choice is 'BUFFER'. This choice has a three item drop
  88. down menu, with buffer related options. (naturally!) The first is 'VIEW', which
  89. will allow you to scroll through a file in all four directions (see the section
  90. "Viewing A File" below). The next choice is 'PRINT', which allows you to just
  91. dump out your file to a printer, in the same manner as in the GEM Desktop,
  92. except that at the end of the printout, the message  "** END OF TEXT **" will
  93. appear.
  94.  
  95.      The final item under 'BUFFER' is 'LIST'. This option will output the text
  96. in a file in a listing format. That is, it will put line numbers, a header with
  97. page number and file information at the top of each page, and print in
  98. condensed format. This is very handy for program listings!!!
  99.  
  100.      The fourth main menu choice is 'EXTRAS'. The first item under this choice
  101. allows you to easily toggle between 50 or 25 row mode. This of course works in
  102. monochrome only. The text for this item will change to reflect the current
  103. vertical resolution. The next item is 'COLOUR FLIP' (and NO, that's not a
  104. spelling mistake, that's the Canadian spelling!!!!) It will invert the screen
  105. colours each time you access it. Finally, there is 'FREE MEMORY'. This option
  106. will allow you to see how much memory is left for the loading of files.
  107.  
  108.      The last main menu choice is 'EXIT', which will of course, exit the
  109. program.
  110.  
  111.  
  112. Changing Buffers
  113. ----------------
  114.  
  115.      Changing buffers is a simple matter. From anywhere in the main menu bar
  116. (horizontal menu bar), just press one of the function keys. For example,
  117. pressing F3 will transfer you to buffer 3, F10 will let you get to buffer 10.
  118.  
  119.      A very quick way to view a file in a buffer is to press <shift> and a
  120. function key at the same time, anywhere in the main menu as above.This will pop
  121. you into viewing a file right away, plus change the buffer at the same time.
  122. Thus, pressing F4 will change the buffer to buffer 4, and put you into viewing
  123. mode at the same time.
  124.  
  125.  
  126. Viewing A File
  127. --------------
  128.  
  129.      When you choose the menu item 'VIEW' or you have pressed <shift> < F-key>
  130. you are placed into view mode. In this mode, you can scroll through a file in
  131. all four directions, page up, page down, search for text (forewards and back-
  132. wards), print a screen of text, and also goto a line number you specify.
  133.  
  134.      The commands are quite simple. To scroll, simply press one of the arrow
  135. keys. Thus the right arrow key will scroll through a line towards the right,
  136. etc. Pressing <shift> and an arrow key will page through a file. Pressing
  137. <shift> and an up/down arrow key will page through the file 18 lines at a time
  138. (36 lines at a time in 50 row mode), and pressing <shift> and a left/right
  139. arrow key will move you either to the 1st column (left) or the the last column
  140. of that line.
  141.  
  142.      Pressing <Home> will move you to the first character of the buffer, and
  143. pressing <shift><Home> will move you to the last line of the buffer.
  144.  
  145.      Pressing F1 will initiate a foreward search. If the text is not found, the
  146. screen will be set to the end of the buffer. F2 is the backward search. Again,
  147. if the text you are searching for is not found, the screen will be set to the
  148. start of the buffer. F3 will repeat the last search, either forward or
  149. backwards. F4 will let you type in a line number to goto. If you give a line
  150. number which is not in the file, then the screen will be set to the end of the
  151. buffer, and a bell will be sounded to tell you that the line does not exist.
  152.  
  153.      At any time while viewing, you can press F10, which will dump the screen
  154. to the printer (which is much quicker than waiting around for an entire file
  155. to be printed when you only need just a few lines of the file dumped).
  156.  
  157.      Also, at any time, press <Esc> to flip between 25 and 50 rows (in mono-
  158. chrome only), <Help> to get on-line help information, and <Undo> to return to
  159. the main menu bar.
  160.  
  161.  
  162. Wrapup
  163. ------
  164.  
  165.      That's about it. If anybody has any ideas on how this program can be
  166. improved, I'd love to hear from you. My address is as follows:
  167.  
  168.         Ignac A. Kolenko Jr.
  169.         372 Roselawn Pl.
  170.         Waterloo, Ont. Canada
  171.         N2L 5P1
  172.  
  173.  
  174.  
  175.                         COMING (kindof) SOON!!!!!!!!!!!
  176.                         ===============================
  177.  
  178. From the creators of ASL, the aSTronomer, the ST Xformer and MEGABLIT comes:
  179.  
  180.     MegaWATt -> the high speed text based windowing environment for the ST.
  181.                 Why put up with the too-complicated-to-use and too-complicated-
  182.                 to-program functions of the standard Atari user interface when
  183.                 most programs don't need them?
  184.                 Compare the speed of ASL.TTP's text output to your favorite
  185.                 text editor!! Notice the difference!
  186.                 Includes a window based desktop and command line interpreter.
  187.  
  188.  MegaBaud II and
  189.     MegaTerm -> the MegaWATt based BBS software and companion terminal sofware.
  190.  
  191.     MegaEdit -> the intelligent source code editor. The word-processor you
  192.                 currently use is not suitable for editing source code!
  193.  
  194.     MegaMake -> the intelligent make utility. Just add compiler. ST BASIC not
  195.                 allowed!
  196.  
  197.   For more information on these programs, you can leave a message to ID #
  198.   73657,2714 on CompuServe.
  199.  
  200.  
  201.